TimePunch Sync Service

Dieser Service stellt Methoden bereit, um Zeiteinträge und Projekte zu finden, die mit einem mobilen Device synchronisiert werden müssen. Und es werden Methoden zum importieren/synchronisieren von Zeiteinträge und Projekten bereitgestellt.

GetUseableSyncUserProfiles

Mit dieser Methode werden alle Profile gesucht, die für eine Daten-Synchronisation zur Verfügung stehen. Als Zusatzinformation wird auch das letzte Synchronisationsdatum zurückgeliefert.

List<SyncUserProfileDto> GetUseableSyncUserProfiles(  
 out TpFault fault,  
 TpAuthentication authentication);

Needed Permission	sync@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		List of TimePunch profiles that can be used for synchronisation purposes.

GetUseableConnectedDevicesForSync

Mit dieser Methode werden verbundene mobile Geräte gesucht, die für eine Daten-Synchronisation zur Verfügung stehen.

Zu jedem verbundenen Gerät, wrdr auch das dazugehörige User Profile mitgeliefert.

List<ConnectedDeviceDto> GetUseableConnectedDevicesForSync(  
 out TpFault fault,  
 TpAuthentication authentication);

Needed Permission	sync@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		List of connected devices that are currently bound and used for synchronsiation purposes.

PullAndSyncConnectedDevices

Diese Methode lädt Daten aus der TimePunch Cloud für die verbundenen Geräte herunter und synchronisiert die Daten mit der lokalen TimePunch Installation.

void PullAndSyncConnectedDevices(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid userProfileId);

Needed Permission	sync@access timeEntries@download projects@download
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userProfileId		The unique id of the user to load the connected devices

BindClientToDevice

Mit dieser Methode kann ein Benutzerprofil mit einem mobilen Gerät verbunden werden. Das Verbinden des Benutzerprofils mit dem mobilen Gerät ist notwendig, damit automatisiert Daten von der Cloud abgerufen werden können.

void BindClientToDevice(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ConnectedDeviceDto connectedDevice);

Needed Permission	sync@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
connectedDevice		One connected device for which the data shall be downloaded from cloud

ReleaseClientFromDevice

Mit dieser Methode wird ein Benutzerprofil von einem verbundenen mobilen Gerät getrennt. Nachdem das Benutzerprofil vom Gerät getrennt wurde, können keine Daten mehr automatisiert abgerufen werden können.

void ReleaseClientFromDevice(  
 out TpFault fault,  
 TpAuthentication authentication,  
 ConnectedDeviceDto connectedDevice);

Needed Permission	sync@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
connectedDevice		One connected device for which the data shall be downloaded from cloud

GetDeviceInfo

Mit dieser Methode werden die gespeicherten Daten des mobilen Geräts abgerufen.

ConnectedDeviceDto GetDeviceInfo(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid deviceConnectionId);

Needed Permission	sync@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
deviceConnectionId		Id of the device for that the device info shall be loaded
Return value		Connected device info

**
**

GetClientInfo

Mit dieser Methode werden die gespeicherten Daten des mobilen Geräts, im Kontext eines Benutzerprofils, abgerufen.

ConnectedDeviceDto GetClientInfo(  
 out TpFault fault,  
 TpAuthentication authentication,  
 Guid deviceConnectionId,  
 Guid clientConnectionId);

Needed Permission	sync@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
deviceConnectionId		Id of the device for that the device info shall be loaded
clientConnectionId		Id of the client connection that is bound with the device (not necessarily the id of the user profile)
Return value		Connected device info

SearchTimeEntriesForSynchronisation

Diese Methode ermittelt alle Zeiteinträge und dessen Projekte, sowie Tätigkeiten und Kunden die für eine Synchronisation ab dem gegebenen Synchronisations-Zeitpunkt gesendet werden können.

Die Methode prüft dabei nicht das Erstellungs- oder Modifikationsdatum, sondern ob das Datum des Zeiteintrags später als der Synchronisations-Zeitpunkt ist.

void SearchTimeEntriesForSynchronisation(  
 out TpFault fault,  
 TpAuthentication authentication,  
 DateTime? lastSyncTime,  
 out IEnumerable<TimeEntryDto> timeEntries,  
 out IEnumerable<ProjectDto> projects,  
 out IEnumerable<TaskDto> commonTasks,  
 out IEnumerable<CustomerDto> customers);

Needed Permission	timeEntries@upload
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
lastSyncTime		Synchronisation-Time
timeEntries	Out	Collection of time entries starting with the given sync time
projects	Out	Projects that are referenced by the found time entries
commonTasks	Out	Common tasks that are referenced by the found time entries
customers	Out	Customers that are referenced by the found time entries

SearchProjectsForSynchronisation

Diese Methode ermittelt die Projekte die für den Benutzer für die eine Synchronisation zur Verfügung stehen.

IEnumerable<ProjectDto> SearchProjectsForSynchronisation(  
 out TpFault fault,  
 TpAuthentication authentication);

Needed Permission	projects@upload
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return Value		Projects that can be used for synchronization purposes.

UpdateLastSyncDate

Diese Methode aktualisiert das letzte Synchronisations-Datum für den Benutzer.

void UpdateLastSyncDate(  
 out TpFault fault,  
 DateTime? syncDate,  
 TpAuthentication authentication);

Needed Permission	timeEntries@upload
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
syncDate		Sync Date to set, or null if the current date shall be used.
authentication		User authentication

ApplyStaticData

Diese Methode importiert die übergebenen Projekte und Kunden und fügt diese mit den bereits Vorhandenen zusammen.

void ApplyStaticData(  
 out TpFault fault,  
 TpAuthentication authentication,  
 IEnumerable<ProjectDto> projects,  
 IEnumerable<TaskDto> commonTasks,  
 IEnumerable<CustomerDto> customers);

Needed Permission	projects@download
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
projects		Collection of projects that shall be imported.
commonTasks		Collection of common tasks that shall be imported.
customers		Collection of customers that shall be imported.

ApplyTimeEntries

Diese Methode importiert die übergebenen Zeiteinträge und fügt diese mit den bereits Vorhandenen zusammen.

void ApplyTimeEntries(  
 out TpFault fault,  
 TpAuthentication authentication,  
 IEnumerable<TimeEntrySaveDto> timeEntries,  
 IEnumerable<ProjectDto> projects,  
 IEnumerable<TaskDto> commonTasks,  
 IEnumerable<CustomerDto> customers);

Needed Permission	projects@download
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
timeEntries		Collection of time entries to impoert
projects		Collection of projects that are referenced by the time entries.
commonTasks		Collection of common tasks that are referenced by the time entries.
customers		Collection of customers that shall be imported.